大綱
撰寫易讀且好維護的程式 - 程式設計規範
Web 應用程式佔客戶端 JavaScript 的比重越來越高,增加了使用 JavaScript 開發大型程式的機會。這意味者,開發者不能只是寫完程式就覺得:『好了,完成了!』伴隨開發完成而來的,是應用程式運作中將出現的錯誤修正、功能新增 / 更新等常態性的變更。
再變更程式時,首要任務就是『了解程式!』此時『閱讀』程式,可能比『寫』程式還更花時間:經過一段時間後,回頭再看自己寫的程式,可能都需要花時間回想,若是看他人的程式,當然需要更多時間了解。因此,撰寫漂亮 (易於閱讀) 的程式是很重要的。
何謂『最漂亮』的程式? 這概念可能過於抽象,其實只要遵循所謂程式設計規範,即可達成。程式設計規範從變數的命名規則、附加空白、縮排到註解的撰寫方法...等,都有統一的規則。遵循這些規則,就可達到維持程式『不骯髒』的最低限度目標。
JavaScript style guide (MDN) 的主要規範
下面列舉幾個『JavaScript style guide (MDN)』中的重要規範。要特別注意的是,此處的重點是『規範』而不是『語法規則』。
基本:
空白:
命名規則:
其它:
『Google JavaScript Style Guide』中有些規範與上面提及的部分重複,以下列出除前述之外,比較重要的項目。
上述規範不只能讓程式較容易閱讀,更必須遵循以撰寫『安全』的程式碼。